<html><head>
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<meta content="text/javascript" http-equiv="content-script-type">
<title>tango.text.Unicode</title>

<link rel="stylesheet" type="text/css" href="css/style.css">
<!--[if lt IE 7]><link rel="stylesheet" type="text/css" href="css/ie56hack.css"><![endif]-->
<script language="JavaScript" src="js/util.js" type="text/javascript"></script>
<script language="JavaScript" src="js/tree.js" type="text/javascript"></script>
<script language="JavaScript" src="js/explorer.js" type="text/javascript"></script>
<script>
function anchorFromTitle(title, path, ext) {
  var url = path + title + "." + ext;
  document.write("<a href='" + url + "'>" + title + "</a>");
  }
</script>
</head><body>
<div id="tabarea"></div><div id="explorerclient"></div>
<div id="content"><script>explorer.initialize("tango.text.Unicode");</script>
        <table class="content">
                <tr><td id="docbody"><h1><a href="http://www.dsource.org/projects/tango/browser/trunk/tango/text/Unicode.d?rev=3461">tango.text.Unicode</a></h1>
                
<b>License:</b><br>
BSD style: see <a href="http://www.dsource.org/projects/tango/wiki/LibraryLicense">license.txt</a><br><br>
<b>Version:</b><br>
Initial release: Sept 2007<br><br>
<b>Authors:</b><br>
Peter<br><br>		Provides case mapping Functions for Unicode Strings. As of now it is
		only 99 % complete, because it does not take into account Conditional
		case mappings. This means the Greek Letter Sigma will not be correctly
		case mapped at the end of a Word, and the Locales Lithuanian, Turkish
		and Azeri are not taken into account during Case Mappings. This means
		all in all around 12 Characters will not be mapped correctly under
		some circumstances.<br><br>		ICU4j also does not handle these cases at the moment.<br><br>		Unittests are written against output from ICU4j<br><br>		This Module tries to minimize Memory allocation and usage. You can
		always pass the output buffer that should be used to the case mapping
		function, which will be resized if necessary.<br><br>
<dl>
<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl"><li>char[] <span class="currsymbol"><a href="http://www.dsource.org/projects/tango/browser/trunk/tango/text/Unicode.d?rev=3461#L44">blockToUpper</a></span>
<script>explorer.outline.addDecl('blockToUpper');</script>(char[] <span class="funcparam">input</span>, char[] <span class="funcparam">output</span> = null, dchar[] <span class="funcparam">working</span> = null); [deprecated]</li></span></dt>
<script>explorer.outline.writeEnabled = false;</script>
<dd>
<font color="black">Converts an Utf8 String to Upper case</font><br><br>
<b>Params:</b><br>
<table>
<tr><td nowrap valign="top" style="padding-right: 8px"><span class="funcparam">input</span></td><td>String to be case mapped</td></tr>
<tr><td nowrap valign="top" style="padding-right: 8px"><span class="funcparam">output</span></td><td>this output buffer will be used unless too small</td></tr></table><br>
<b>Returns:</b><br>
the case mapped string<br><br></dd>
<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl"><li>char[] <span class="currsymbol"><a href="http://www.dsource.org/projects/tango/browser/trunk/tango/text/Unicode.d?rev=3461#L93">toUpper</a></span>
<script>explorer.outline.addDecl('toUpper');</script>(char[] <span class="funcparam">input</span>, char[] <span class="funcparam">output</span> = null);</li></span></dt>
<script>explorer.outline.writeEnabled = false;</script>
<dd>
<font color="black">Converts an Utf8 String to Upper case</font><br><br>
<b>Params:</b><br>
<table>
<tr><td nowrap valign="top" style="padding-right: 8px"><span class="funcparam">input</span></td><td>String to be case mapped</td></tr>
<tr><td nowrap valign="top" style="padding-right: 8px"><span class="funcparam">output</span></td><td>this output buffer will be used unless too small</td></tr></table><br>
<b>Returns:</b><br>
the case mapped string<br><br></dd>
<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl"><li>wchar[] <span class="currsymbol"><a href="http://www.dsource.org/projects/tango/browser/trunk/tango/text/Unicode.d?rev=3461#L149">toUpper</a></span>
<script>explorer.outline.addDecl('toUpper');</script>(wchar[] <span class="funcparam">input</span>, wchar[] <span class="funcparam">output</span> = null);</li></span></dt>
<script>explorer.outline.writeEnabled = false;</script>
<dd>
<font color="black">Converts an Utf16 String to Upper case</font><br><br>
<b>Params:</b><br>
<table>
<tr><td nowrap valign="top" style="padding-right: 8px"><span class="funcparam">input</span></td><td>String to be case mapped</td></tr>
<tr><td nowrap valign="top" style="padding-right: 8px"><span class="funcparam">output</span></td><td>this output buffer will be used unless too small</td></tr></table><br>
<b>Returns:</b><br>
the case mapped string<br><br></dd>
<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl"><li>dchar[] <span class="currsymbol"><a href="http://www.dsource.org/projects/tango/browser/trunk/tango/text/Unicode.d?rev=3461#L203">toUpper</a></span>
<script>explorer.outline.addDecl('toUpper');</script>(dchar[] <span class="funcparam">input</span>, dchar[] <span class="funcparam">output</span> = null);</li></span></dt>
<script>explorer.outline.writeEnabled = false;</script>
<dd>
<font color="black">Converts an Utf32 String to Upper case</font><br><br>
<b>Params:</b><br>
<table>
<tr><td nowrap valign="top" style="padding-right: 8px"><span class="funcparam">input</span></td><td>String to be case mapped</td></tr>
<tr><td nowrap valign="top" style="padding-right: 8px"><span class="funcparam">output</span></td><td>this output buffer will be used unless too small</td></tr></table><br>
<b>Returns:</b><br>
the case mapped string<br><br></dd>
<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl"><li>char[] <span class="currsymbol"><a href="http://www.dsource.org/projects/tango/browser/trunk/tango/text/Unicode.d?rev=3461#L245">toLower</a></span>
<script>explorer.outline.addDecl('toLower');</script>(char[] <span class="funcparam">input</span>, char[] <span class="funcparam">output</span> = null);</li></span></dt>
<script>explorer.outline.writeEnabled = false;</script>
<dd>
<font color="black">Converts an Utf8 String to Lower case</font><br><br>
<b>Params:</b><br>
<table>
<tr><td nowrap valign="top" style="padding-right: 8px"><span class="funcparam">input</span></td><td>String to be case mapped</td></tr>
<tr><td nowrap valign="top" style="padding-right: 8px"><span class="funcparam">output</span></td><td>this output buffer will be used unless too small</td></tr></table><br>
<b>Returns:</b><br>
the case mapped string<br><br></dd>
<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl"><li>wchar[] <span class="currsymbol"><a href="http://www.dsource.org/projects/tango/browser/trunk/tango/text/Unicode.d?rev=3461#L301">toLower</a></span>
<script>explorer.outline.addDecl('toLower');</script>(wchar[] <span class="funcparam">input</span>, wchar[] <span class="funcparam">output</span> = null);</li></span></dt>
<script>explorer.outline.writeEnabled = false;</script>
<dd>
<font color="black">Converts an Utf16 String to Lower case</font><br><br>
<b>Params:</b><br>
<table>
<tr><td nowrap valign="top" style="padding-right: 8px"><span class="funcparam">input</span></td><td>String to be case mapped</td></tr>
<tr><td nowrap valign="top" style="padding-right: 8px"><span class="funcparam">output</span></td><td>this output buffer will be used unless too small</td></tr></table><br>
<b>Returns:</b><br>
the case mapped string<br><br></dd>
<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl"><li>dchar[] <span class="currsymbol"><a href="http://www.dsource.org/projects/tango/browser/trunk/tango/text/Unicode.d?rev=3461#L356">toLower</a></span>
<script>explorer.outline.addDecl('toLower');</script>(dchar[] <span class="funcparam">input</span>, dchar[] <span class="funcparam">output</span> = null);</li></span></dt>
<script>explorer.outline.writeEnabled = false;</script>
<dd>
<font color="black">Converts an Utf32 String to Lower case</font><br><br>
<b>Params:</b><br>
<table>
<tr><td nowrap valign="top" style="padding-right: 8px"><span class="funcparam">input</span></td><td>String to be case mapped</td></tr>
<tr><td nowrap valign="top" style="padding-right: 8px"><span class="funcparam">output</span></td><td>this output buffer will be used unless too small</td></tr></table><br>
<b>Returns:</b><br>
the case mapped string<br><br></dd>
<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl"><li>char[] <span class="currsymbol"><a href="http://www.dsource.org/projects/tango/browser/trunk/tango/text/Unicode.d?rev=3461#L398">toFold</a></span>
<script>explorer.outline.addDecl('toFold');</script>(char[] <span class="funcparam">input</span>, char[] <span class="funcparam">output</span> = null);</li></span></dt>
<script>explorer.outline.writeEnabled = false;</script>
<dd>
<font color="black">Converts an Utf8 String to Folding case
 Folding case is used for case insensitive comparsions.</font><br><br>
<b>Params:</b><br>
<table>
<tr><td nowrap valign="top" style="padding-right: 8px"><span class="funcparam">input</span></td><td>String to be case mapped</td></tr>
<tr><td nowrap valign="top" style="padding-right: 8px"><span class="funcparam">output</span></td><td>this output buffer will be used unless too small</td></tr></table><br>
<b>Returns:</b><br>
the case mapped string<br><br></dd>
<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl"><li>wchar[] <span class="currsymbol"><a href="http://www.dsource.org/projects/tango/browser/trunk/tango/text/Unicode.d?rev=3461#L447">toFold</a></span>
<script>explorer.outline.addDecl('toFold');</script>(wchar[] <span class="funcparam">input</span>, wchar[] <span class="funcparam">output</span> = null);</li></span></dt>
<script>explorer.outline.writeEnabled = false;</script>
<dd>
<font color="black">Converts an Utf16 String to Folding case
 Folding case is used for case insensitive comparsions.</font><br><br>
<b>Params:</b><br>
<table>
<tr><td nowrap valign="top" style="padding-right: 8px"><span class="funcparam">input</span></td><td>String to be case mapped</td></tr>
<tr><td nowrap valign="top" style="padding-right: 8px"><span class="funcparam">output</span></td><td>this output buffer will be used unless too small</td></tr></table><br>
<b>Returns:</b><br>
the case mapped string<br><br></dd>
<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl"><li>dchar[] <span class="currsymbol"><a href="http://www.dsource.org/projects/tango/browser/trunk/tango/text/Unicode.d?rev=3461#L495">toFold</a></span>
<script>explorer.outline.addDecl('toFold');</script>(dchar[] <span class="funcparam">input</span>, dchar[] <span class="funcparam">output</span> = null);</li></span></dt>
<script>explorer.outline.writeEnabled = false;</script>
<dd>
<font color="black">Converts an Utf32 String to Folding case
 Folding case is used for case insensitive comparsions.</font><br><br>
<b>Params:</b><br>
<table>
<tr><td nowrap valign="top" style="padding-right: 8px"><span class="funcparam">input</span></td><td>String to be case mapped</td></tr>
<tr><td nowrap valign="top" style="padding-right: 8px"><span class="funcparam">output</span></td><td>this output buffer will be used unless too small</td></tr></table><br>
<b>Returns:</b><br>
the case mapped string<br><br></dd>
<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl"><li>bool <span class="currsymbol"><a href="http://www.dsource.org/projects/tango/browser/trunk/tango/text/Unicode.d?rev=3461#L529">isDigit</a></span>
<script>explorer.outline.addDecl('isDigit');</script>(dchar <span class="funcparam">ch</span>);</li></span></dt>
<script>explorer.outline.writeEnabled = false;</script>
<dd>
<font color="black">Determines if a character is a digit. It returns true for decimal
 digits only.</font><br><br>
<b>Params:</b><br>
<table>
<tr><td nowrap valign="top" style="padding-right: 8px"><span class="funcparam">ch</span></td><td>the character to be inspected</td></tr></table><br></dd>
<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl"><li>bool <span class="currsymbol"><a href="http://www.dsource.org/projects/tango/browser/trunk/tango/text/Unicode.d?rev=3461#L541">isLetter</a></span>
<script>explorer.outline.addDecl('isLetter');</script>(int <span class="funcparam">ch</span>);</li></span></dt>
<script>explorer.outline.writeEnabled = false;</script>
<dd>
<font color="black">Determines if a character is a letter.</font><br><br>
<b>Params:</b><br>
<table>
<tr><td nowrap valign="top" style="padding-right: 8px"><span class="funcparam">ch</span></td><td>the character to be inspected</td></tr></table><br></dd>
<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl"><li>bool <span class="currsymbol"><a href="http://www.dsource.org/projects/tango/browser/trunk/tango/text/Unicode.d?rev=3461#L558">isLetterOrDigit</a></span>
<script>explorer.outline.addDecl('isLetterOrDigit');</script>(int <span class="funcparam">ch</span>);</li></span></dt>
<script>explorer.outline.writeEnabled = false;</script>
<dd>
<font color="black">Determines if a character is a letter or a
 decimal digit.</font><br><br>
<b>Params:</b><br>
<table>
<tr><td nowrap valign="top" style="padding-right: 8px"><span class="funcparam">ch</span></td><td>the character to be inspected</td></tr></table><br></dd>
<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl"><li>bool <span class="currsymbol"><a href="http://www.dsource.org/projects/tango/browser/trunk/tango/text/Unicode.d?rev=3461#L574">isLower</a></span>
<script>explorer.outline.addDecl('isLower');</script>(dchar <span class="funcparam">ch</span>);</li></span></dt>
<script>explorer.outline.writeEnabled = false;</script>
<dd>
<font color="black">Determines if a character is a lower case letter.
 </font><br><br>
<b>Params:</b><br>
<table>
<tr><td nowrap valign="top" style="padding-right: 8px"><span class="funcparam">ch</span></td><td>the character to be inspected</td></tr></table><br></dd>
<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl"><li>bool <span class="currsymbol"><a href="http://www.dsource.org/projects/tango/browser/trunk/tango/text/Unicode.d?rev=3461#L587">isTitle</a></span>
<script>explorer.outline.addDecl('isTitle');</script>(dchar <span class="funcparam">ch</span>);</li></span></dt>
<script>explorer.outline.writeEnabled = false;</script>
<dd>
<font color="black">Determines if a character is a title case letter.
 In case of combined letters, only the first is upper and the second is lower.
 Some of these special characters can be found in the croatian and greek language.
 </font><br><br>
<b>See Also:</b><br>
<br><br>
<b>http:</b><br>//en.wikipedia.org/wiki/Capitalization<br><br>
<b>Params:</b><br>
<table>
<tr><td nowrap valign="top" style="padding-right: 8px"><span class="funcparam">ch</span></td><td>the character to be inspected</td></tr></table><br></dd>
<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl"><li>bool <span class="currsymbol"><a href="http://www.dsource.org/projects/tango/browser/trunk/tango/text/Unicode.d?rev=3461#L597">isUpper</a></span>
<script>explorer.outline.addDecl('isUpper');</script>(dchar <span class="funcparam">ch</span>);</li></span></dt>
<script>explorer.outline.writeEnabled = false;</script>
<dd>
<font color="black">Determines if a character is a upper case letter.
 </font><br><br>
<b>Params:</b><br>
<table>
<tr><td nowrap valign="top" style="padding-right: 8px"><span class="funcparam">ch</span></td><td>the character to be inspected</td></tr></table><br></dd>
<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl"><li>bool <span class="currsymbol"><a href="http://www.dsource.org/projects/tango/browser/trunk/tango/text/Unicode.d?rev=3461#L616">isWhitespace</a></span>
<script>explorer.outline.addDecl('isWhitespace');</script>(dchar <span class="funcparam">ch</span>);</li></span></dt>
<script>explorer.outline.writeEnabled = false;</script>
<dd>
<font color="black">Determines if a character is a Whitespace character.
 Whitespace characters are characters in the
 General Catetories Zs, Zl, Zp without the No Break
 spaces plus the control characters out of the ASCII
 range, that are used as spaces:
 TAB VT LF FF CR FS GS RS US NL</font><br><br>
<b>WARNING:</b><br>look at isSpace, maybe that function does
          more what you expect.<br><br>
<b>Params:</b><br>
<table>
<tr><td nowrap valign="top" style="padding-right: 8px"><span class="funcparam">ch</span></td><td>the character to be inspected</td></tr></table><br></dd>
<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl"><li>bool <span class="currsymbol"><a href="http://www.dsource.org/projects/tango/browser/trunk/tango/text/Unicode.d?rev=3461#L639">isSpace</a></span>
<script>explorer.outline.addDecl('isSpace');</script>(dchar <span class="funcparam">ch</span>);</li></span></dt>
<script>explorer.outline.writeEnabled = false;</script>
<dd>
<font color="black">Detemines if a character is a Space character as
 specified in the Unicode Standart.</font><br><br>
<b>WARNING:</b><br>look at isWhitepace, maybe that function does
          more what you expect.<br><br>
<b>Params:</b><br>
<table>
<tr><td nowrap valign="top" style="padding-right: 8px"><span class="funcparam">ch</span></td><td>the character to be inspected</td></tr></table><br></dd>
<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl"><li>bool <span class="currsymbol"><a href="http://www.dsource.org/projects/tango/browser/trunk/tango/text/Unicode.d?rev=3461#L659">isPrintable</a></span>
<script>explorer.outline.addDecl('isPrintable');</script>(dchar <span class="funcparam">ch</span>);</li></span></dt>
<script>explorer.outline.writeEnabled = false;</script>
<dd>
<font color="black">Detemines if a character is a printable character as
 specified in the Unicode Standart.</font><br><br>
<b>WARNING:</b><br>look at isWhitepace, maybe that function does
          more what you expect.<br><br>
<b>Params:</b><br>
<table>
<tr><td nowrap valign="top" style="padding-right: 8px"><span class="funcparam">ch</span></td><td>the character to be inspected</td></tr></table><br></dd></dl></td></tr>
                <tr><td id="docfooter">
                        Copyright (c) 2007 Peter Triller. All rights reserved :: page rendered by CandyDoc. Generated by <a href="http://code.google.com/p/dil">dil</a> on Sun Jun  8 17:12:57 2008.
                </td></tr>
        </table>
</div>
<script></script>
</body></html>